home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / opus / wink_101.zip / WINK.DOC < prev    next >
Text File  |  1992-11-12  |  12KB  |  371 lines
  1.  
  2.  
  3.  
  4.  
  5. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  6.                            QWK as a WINK  ;-)
  7. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  8.  
  9.  
  10. -------------
  11. INTRODUCTION:
  12. -------------
  13.  
  14. WINK is a door for the Opus CBCS.  WINK provides your users access to
  15. messages using the QWK mail format.  It is very tightly intergrated
  16. with Opus, making it easy to set up for you and easy to operate for
  17. your users.
  18.  
  19. What does WINK cost?  The same as my other Opus programs OBUL, OASWAP,
  20. and ARKALOG.  Nothing.  WINK is free software in the Opus tradition.
  21. Enjoy it and please report any "features-of-ill-repute" to the author.
  22.  
  23. There is a registration option mentioned later in this document.
  24.  
  25.       
  26. ---------
  27. FEATURES:
  28. ---------
  29.  
  30. The following is a list of the major features found in WINK.  If you
  31. would like to see something added to this list, contact the author.
  32.  
  33. - works with Opus 1.1x and up
  34. - supports multiline/multitask usage
  35. - works with any com port via FOSSIL
  36. - runs remote and local
  37. - runs stand alone if last login was local
  38. - sysop defined file archivers
  39. - sysop defined transfer protocols
  40. - handles messages of any size
  41. - no door/drop file needed, pulls info from Opus files
  42. - checks privileges & locks for area access
  43. - checks privileges & locks for edit access
  44. - prevents forged messages
  45. - prevents adding messages to readonly areas
  46. - private message posted in public area is made public
  47. - filenames can be task number tagged
  48. - generates echotoss.log file
  49. - update all last read pointers
  50. - does not download authored messages
  51. - commands can be stacked
  52. - new pine scent with no greasy residue
  53.  
  54.  
  55. ---------
  56. MANIFEST:
  57. ---------
  58.  
  59. WINK.HIS     - release history & quick upgrade instructions
  60. WINK11.EXE   - the Opus 1.1x executable
  61. WINK17.EXE   - the Opus 1.7x/1.8x/1.9x executable
  62. WINK.CFG     - quick start configuration file
  63. WINK_CFG.DOC - docs for configuration file
  64. WINK.DOC     - this documentation
  65.  
  66. You may have a package that contains only one executable.
  67.  
  68.  
  69. ------------
  70. QUICK START:
  71. ------------
  72.  
  73. If you are upgrading from the last release, you should read
  74. WINK.HIS for quick upgrade instructions.
  75.  
  76. If you are installing WINK for the first time, or you are
  77. skipping some releases, then follow these instructions.
  78.  
  79. - copy all files to your Opus directory
  80. - rename the appropriate EXE version to WINK.EXE
  81. - edit WINK.CFG and follow directions listed there
  82. - add an Opus menu option, for example:
  83.   _OUTSIDE  Normal  "WINK" = DOS c:\opus\wink.exe
  84. - time to rock-n-roll (Rush preferred)
  85.  
  86. NOTE:  The quick start CFG file requires that PKZIP,
  87.        PKUNZIP, and DSZ be located in your PATH.
  88.  
  89.  
  90. ------------
  91. REGISTERING:
  92. ------------
  93.  
  94. If you decided to send a monetary donation to the author you will:
  95.  
  96. - receive a special version of the WINK Door which
  97.   adds a plaque proclaiming your registered support
  98.  
  99. - receive express attention in submitted bug fixes
  100.   and any enhancements that you request
  101.  
  102. - receive beta releases of new versions and planned
  103.   new support utilities
  104.  
  105. - see to it that WINK development continues for the
  106.   enjoyment of future generations of Cool Shades
  107.  
  108. - receive a registration program to auto register
  109.   future releases
  110.  
  111. - get that warm fuzzy feeling
  112.  
  113. To register WINK, send not more than US$25.  Be sure to select a
  114. shipping option from the list below and include a copy of the
  115. SYSOP variable from the SYSTEM SECTION of your Opus BBS.CTL file.
  116.  
  117. This name will be used as the registration key.  It will also be
  118. placed in the QWK control file that is sent to your users and
  119. will also be placed on your registration plaque.  If this name
  120. is incorrect, please include an explanation.
  121.  
  122.         SYSTEM SECTION
  123.         %
  124.         SYSOP    Keith Ford
  125.         %
  126.  
  127. When selecting a shipping option, be sure to include ALL the needed
  128. information such as passwords, phone numbers, addresses, etc.
  129.  
  130. The shipping options are many.  Please pick one.
  131.  
  132. - uuencode and email (preferred)
  133.   [ need your email address]
  134.  
  135. - file attach to your Fidonet node
  136.   [ need your net address]
  137.  
  138. - login to your bbs and upload
  139.   [ need login/password/filearea with upload privileges ]
  140.  
  141. - snail mail
  142.   [ need your address ]
  143.  
  144. - personal delivery
  145.   [ need your car ]
  146.  
  147.  
  148. ----------------------
  149. CONTACTING THE AUTHOR:
  150. ----------------------
  151.  
  152. BBS NAME:  Micro Magic                 __
  153. PHONE:     +1 205 830 2362            /  \  Can you identify
  154. MODEM:     USR DS - HST/V32bis        \__/  this object?
  155. FREQ:      WINK                       [__]
  156. FIDONET:   1:373/12
  157. INTERNET:  sysop@umagic.fidonet.org
  158. SNAIL:     203 Creek Trail, Madison, AL, 35758
  159. ICBM:      34 44 18 N / 86 35 19 W
  160.  
  161. WINK will always be available on Micro Magic.  The latest version
  162. can be file requested with the magic name WINK, which will contain
  163. all the executables.  You can also request WINK for specific versions
  164. of Opus with magic names WINK11 & WINK17.
  165.  
  166.  
  167. ----------------
  168. VERSION NUMBERS:
  169. ----------------
  170.  
  171. The version number of WINK will always be a 3 digit hexadecimal number.
  172. The version number will be X.Y.Z and the archived filename will be
  173. WINK_XYZ.??? where X, Y, & Z are defined as follows.
  174.  
  175.  X - major change, if you use this EXE you MUST change your
  176.      CFG file according to the release notes
  177.  
  178.  Y - new features, you can use this EXE without changing your
  179.      CFG file, but to use the new features you must change
  180.      your CFG file according to the release notes
  181.  
  182.  Z - bug fix, simply replace the executable and read the
  183.      relese notes
  184.  
  185.  
  186. ----------------
  187. PROGRAM DETAILS:
  188. ----------------
  189.  
  190. MULTILINE SUPPORT
  191.  
  192. WINK read the Opus PRM file for much of its information.  If you have a
  193. multiline system, you will have multiple PRM files.  For WINK to work,
  194. it must be told where the PRM file is located.  You can do this with
  195. the OPUS environment variable or with the -PRM command line parameter. 
  196. For more information on where WINK looks for files, read the section
  197. named "WHERE WINK LOOKS FOR FILES" in this text.
  198.  
  199. Any filename specified with WINK that contains a # or ## will
  200. be modified such that the # or ## is replaced with the hexadecimal
  201. task number.  If these files are not found, the name is modified
  202. again to exclude the task numbers.  If task number is decimal 10,
  203. then WINK##.CFG would be WINK0A.cfg, then WINK.CFG.
  204.  
  205.  
  206. RUNNING LOCAL OR STANDALONE
  207.  
  208. When in one of these modes, WINK places <bbsid>.QWK in the temporary
  209. directory and looks for <bbsid>.REP there too.  The temporary directory
  210. is found in the PRM file or from the WINK -tmp command line argument.
  211.  
  212. WINK reads the LASTUSER record, so running STANDALONE will run as if
  213. that person were logged on.  Use OPUS -K if you need to change the
  214. LASTUSER record to be yours.
  215.  
  216.  
  217. AREA NAMING
  218.  
  219. The name of a message area is limited to 10 characters.  In Opus 1.1x,
  220. the first 10 characters of the message area name are used.  In Opus
  221. 1.7x, the first area name definition in the CTL file is used.  Opus allows
  222. you to define this area name two different ways.
  223.  
  224. (#1)   AREA   0001   Meadow
  225.  
  226. (#2)   AREA   0002
  227.        NAME   Meadow
  228.  
  229.  
  230. WHERE WINK LOOKS FOR FILES
  231.  
  232. look for OPUS environment variable pointing to BBS.PRM
  233. check command line parameters:
  234.   -log    : path to log file
  235.   -prm    : path to bbs.prm file
  236.   -sys    : directory containing area definitions
  237.   -lastus : path to LASTUS file
  238.   -opus   : directory of opusroot (echotoss & lastus for 1.1x)
  239.   -tmp    : directory for temporary work files
  240.   -cfg    : path to wink.cfg file
  241.   -usr    : path to wink.usr file
  242. if OPUS and !-opus, form opusroot from OPUS by stripping BBS.PRM
  243. else if !OPUS and -opus, form PRM from opusroot plus BBS.PRM
  244. if !PRM, look in current directory
  245. if !LASTUS, 1.1x uses opusroot & 1.7x looks in PRM
  246. if !TMP, look in PRM, append WINKxx.TMP
  247. if !SYS, look in PRM
  248.   1.1x looks for SYSTEMxx.DAT files
  249.   1.7x looks for sysmsg.dat
  250. if !CFG, look in current directory
  251. if !USR, look in current directory
  252. echotoss.log uses
  253.   1.1x - in opusroot
  254.   1.7x - pulled from PRM
  255.  
  256.  
  257. WHICH FILES ARE MODIFIED
  258.  
  259. wink##.usr
  260. last read files
  261. lastus##.dat
  262.  
  263.  
  264. MENU DESCRIPTION
  265.  
  266. C........user configuration for packer & protocol 
  267. #........toggle area # on and off
  268. #f.......toggle flag for area # on and off
  269.          (only P flag supported for Personal messages)
  270. L........list available message areas
  271. L#.......list available message areas starting with #
  272. LS.......list selected message areas
  273. LS#......list selected message areas starting with #
  274. D........download QWK packet
  275. DP.......override area flags, download only personal messages
  276. DA.......override area flags, download all messages
  277. U........upload REP packet
  278. Q........quit back to the bbs
  279. G........goodbye and logoff now
  280. =........credits
  281. *........registration plaque
  282. ?........help
  283.  
  284.  
  285. ----------------
  286. WINK.CFG FORMAT:
  287. ----------------
  288.  
  289. See WINK_CFG.DOC file for this information.
  290.  
  291.  
  292. ----------------
  293. WINK.USR FORMAT:
  294. ----------------
  295.  
  296. You should not need to worry about this file.  If something goes
  297. wrong, you can edit it by hand to an extent.  Following is the
  298. format for a record in this file.  This record is repeated for
  299. each active WINK user.
  300.  
  301. User Name
  302. userflags
  303. crc-of-packer-menu-text
  304. crc-of-protocol-menu-text
  305. area# flags
  306. area# flags
  307. area# flags
  308.  
  309.  
  310. -----------
  311. THE AUTHOR:
  312. -----------
  313.  
  314. Other software available from the author.
  315.  
  316. OBUL    - Generate a .BBS file that presents a menu to a caller.
  317.           This menu is based upon a list of bulletins provided
  318.           by the sysop.  Any bulletins which have been modified
  319.           since the user last visited, are marked on the menu.
  320.           This works for Opus 1.1x and up.
  321.  
  322. ARKALOG - Archive a log file with date embedded in the filename.
  323.           Such as OLOG9210.LZH would be my Opus log for the 10th
  324.           month of 1992.  This program also has a day of the week
  325.           check to automate weekly functions.  It will work with
  326.           any Opus, or any bbs.
  327.  
  328. OASWAP  - In Opus 1.1x message & file areas are tied together.
  329.           OASWAP will allow you to swap between areas the message
  330.           or file information independently of one another.  This
  331.           works with Opus 1.1x only.
  332.  
  333.  
  334. -------------
  335. FUTURE PLANS:
  336. -------------
  337.  
  338. - sysop defined menu coloring
  339. - sysop defined area names
  340. - sysop exclusion of certain message areas
  341. - multiple language using '~'
  342. - change last read pointer on exit only
  343. - menu option to set/reset last read pointers
  344. - sysop defined NEWFILES generation command
  345. - use PEEK privs/locks for private in public echos
  346. - handle area number greater than 255
  347. - send messages that match a search string
  348.  
  349.  
  350. ---------------
  351. KNOWN PROBLEMS:
  352. ---------------
  353.  
  354. Last Read Pointers not updated for sysop.
  355.  
  356. The WINK tear line may be missing from some messages.
  357.  
  358. The QWK format does not have a way to include Fidonet addresses.
  359. Therefore, there is no support for net mail messages.
  360.  
  361.  
  362. ------------------------------
  363. FOR THE TECHNO HUMOR IMPAIRED:
  364. ------------------------------
  365.  
  366. An emoticon is a small figure (icon) comprised of ASCII characters
  367. used to denote and emotion.  Many emoticons depict a face and require
  368. you to tilt your head (or monitor) to the left (or right).  The ";-)"
  369. is an emoticon representing a winking face, to denote humor,
  370. understanding, sarcasm, and such.  So there you have
  371.